home *** CD-ROM | disk | FTP | other *** search
/ JCSM Shareware Collection 1993 November / JCSM Shareware Collection - 1993-11.iso / cl720 / bugtrakr.lzh / BUGTRAKR.DOC < prev    next >
Text File  |  1993-05-31  |  9KB  |  209 lines
  1.                                 What is BugTrakr?
  2.  
  3. BugTrakr (Bug Tracker) is a database program that keeps track of
  4. computer program bugs. But it is more than that. It makes it easy to
  5. document, sort and track the progress of fixes to bugs and implementations
  6. of enhancements.
  7.  
  8.                              Who would use BugTrakr?
  9.  
  10. BugTrakr is for three types of people, those who develop software, those
  11. who perform quality assurance on software and those who review software.
  12. Or, it is for anyone who would like an easy way of writing a note about
  13. any change they would like in a computer program.
  14.  
  15. At PC Consulting, we call these notes "Software Change Requests", or SCRs
  16. for short.
  17.  
  18.                                   Types of SCRs
  19.  
  20. There are two types of SCRs. A problem is something wrong with the program.
  21. It does not perform the way it should; it is a bug. An enhancement is a
  22. feature that someone would like to see added to the program; it adds
  23. functionality.
  24.  
  25.                              Classification of SCRs
  26.  
  27. SCRs (problems or enhancements) can be written against the program code
  28. itself or the documentation. Documentation includes the manual or help.
  29. The two classifications are program code and documentation.
  30.  
  31.                                     Severity
  32.  
  33. There are three levels of severity supported by BugTrakr. They are Critical,
  34. Moderate and Slight. We use these levels of severity to guide us in what
  35. gets fixed or enhanced first. We work only on Critical bugs and enhancements
  36. unless, for some reason, we cannot procede. Then we work on Moderates. And,
  37. finally, we work on Slights. Our clients assign the severity which controls
  38. what we work on first.
  39.  
  40.                                        SCR Form
  41.  
  42. We have a pre-printed form that we give to our clients to report bugs to us.
  43. A similar form is available when you register the product.
  44.  
  45.                               BugTrakr is ShareWare
  46.  
  47. This means that it is not free, but you are permitted to "try before you buy".
  48. When you decide to register it, there is a form on-line. Press F1 for help,
  49. then choose the Registration option. Print the screen, fill out the form and,
  50. with $20, send it to us.
  51.  
  52.                                BugTrakr 20-Record Limit
  53.  
  54. The ShareWare product is limited to 20 records. This should give you plenty
  55. of trial space. The registered product, of course, is unlimited.
  56.  
  57. Page 1
  58.  
  59.                                    Starting BugTrakr
  60.  
  61. The first thing you see when you start BugTrakr is this:
  62.  
  63. ╔═════════════════════════════════════════════════════╗
  64. ║     BugTrakr - Software Change Request Database     ║
  65. ║                 Memory Free:  206088                ║
  66. ║                     Version 1.13                    ║
  67. ║ Registered: 20 Record ShareWare - $20 to Register!  ║
  68. ╟─────────────────────────────────────────────────────╢
  69. ║     Date:  5/31/93                                  ║
  70. ║   Client: PCC                                       ║
  71. ║  Product: BugTrakr                                  ║
  72. ╟─────────────────────────────────────────────────────╢
  73. ║                    Edit SCR Log                     ║
  74. ║                      Reports                        ║
  75. ║             Client & Product Information            ║
  76. ║             "Esc" or "Escape" to Exit...            ║
  77. ╚═════════════════════════════════════════════════════╝
  78.  
  79. Memory Free: shows how much free memory is available for BugTrakr's
  80. overlay files and any other programs you might want to load.
  81.  
  82. Version 1.13 is strictly the ShareWare Demo Version. You get a later
  83. version if you register.
  84.  
  85. Date: is today's date, just for reference.
  86.  
  87. Client: Shows your current database client selection. You can keep databases
  88. for as many clients as you want.
  89.  
  90. Product: Shows your current database product selection. You can keep databases
  91. for as many products for a client as you want.
  92.  
  93. "Edit SCR Log" is the menu choice that is used most often. It opens a table
  94. of SCRs. This table can be sorted three ways: by SCR number, by Status and
  95. by Synopsis. You can enter new SCRs, delete SCRs or modify existing SCRs
  96. here.
  97.  
  98. "Reports" gives you a menu of SCRs that can be printed to paper, to screen or
  99. to file.
  100.  
  101. "Client & Product Information" displays a form for you to change the
  102. client code and the product name for whom you want to track SCRs.
  103.  
  104. Look at the last four lines at the bottom of the screen.
  105. The information on the cyan (light blue) bar changes when you go from
  106. one function to another. It tells you what keys are active. The last
  107. three lines are usually green. This is the mini-help area. It changes
  108. with each different field and every menu choice. Watching this area is
  109. all most people need to learn this program.
  110.  
  111. F1 help is available at this main menu. It is also available elsewhere as
  112. described in the mini-help. You can modify mini-help to suit your own
  113. taste... see F1 help.
  114.  
  115. Page 2
  116.  
  117.                                      Edit SCR Log
  118.  
  119. Choosing this item from the main menu displays a screen like this:
  120.  
  121. ╔═══════════════════════════════════════════════════════════════════════╗
  122. ║              Software Change Request (SCR) LOG by Number              ║
  123. ║                     Client:PCC                                        ║
  124. ║ LOCATE:            Product:BugTrakr                                   ║
  125. ║                    SCR Qty:     1                                     ║
  126. ║  SCR#   Status    Synopsis                                            ║
  127. ║     1     O1      Sample SCR                                          ║
  128. ║                                                                       ║
  129. ║                                                                       ║
  130. ║                                                                       ║
  131. ║                                                                       ║
  132. ║                                                                       ║
  133. ╚═ Tab/ShftTab: Change Sort══ AltM: Sort Menu══ AltS: Search for String═╝
  134.  
  135. This is a table of SCRs. The top portion shows your client code and product.
  136. There are three columns of information: SCR#, Status and Synopsis. The
  137. position of these three columns changes in accordance with the sort order.
  138. Use the Tab or the Shift-Tab key to change the sort. This sample shows the
  139. table sorted by SCR#. Press Tab to have the table resorted by Status. Status
  140. would then move to the left and SCR# would wrap around to the right. Instead
  141. of the Tab key, you can select a tiny menu of sort selections with the AltM key.
  142.  
  143. You can search the Synopsis field and the large description field for a string
  144. with the AltS key. This proves quite useful when you can't remember wether or
  145. not an SCR already exists for a particular problem.
  146.  
  147. Point to a record and press Enter to open the red editing screen:
  148.  
  149. ╔═══════════════ Update SCR Log    Editing an existing record   ═══════════════╗
  150. ║   PCC        BugTrakr                                  1Version:0.03A-Beta   ║
  151. ║  SCR#:   1  5/31/93 2Reporter:Your Name                      Edited: 5/31/93 ║
  152. ║            3Type:Enhancement Class:Documentation Severity:Slight             ║
  153. ║                                                                              ║
  154. ║4Menu Choices:N/A                                                             ║
  155. ║      5Status:O1 Open: to be resolved normally, highest severity first.       ║
  156. ║    6Synopsis:Sample SCR                                                      ║
  157. ║ 7Description:SCR stands for Software Change Request. BugTrakr keeps          ║
  158. ║ |            Track of these "bugs".                                          ║
  159. ║ (Alt-7)                                                                      ║
  160. ║                                                                              ║
  161. ║                                                                              ║
  162. ║                                                                              ║
  163. ║  8Resolution:                                                                ║
  164. ╚══════════════════════════════════════════════════════════════════════════════╝
  165.  
  166. You will see the same screen if you press Del to delete a record, except the
  167. message will say press Enter to Delete.
  168.  
  169. You will see the same screen if you press Ins to insert a record, except the
  170. message will say adding a record and the fields will mostly be blank.
  171.  
  172. If you want to quickly get to a field before you forget something you can
  173. choose Alt7, for example, to get to the Description field. Then you can go
  174. back to the fields you skipped and enter the info at your leisure.
  175.  
  176. Page 3
  177.  
  178.                                         Reports
  179.  
  180. ╔══════════════════╗
  181. ║      Reports     ║
  182. ╟────By Severity───╢
  183. ║       Open       ║
  184. ║      Closed      ║
  185. ║    All (O/C/A)   ║
  186. ╟───────Other──────╢
  187. ║     All by #     ║
  188. ║  All by Synopsis ║
  189. ║    Open Detail   ║
  190. ║   Closed Detail  ║
  191. ║ SCR Cover Sheets ║
  192. ║   Status Codes   ║
  193. ╚══════════════════╝
  194.  
  195. The reports menu has two sections "By Severity" and "Other".
  196.  
  197. To register, see F1 Help, "Registration". Print Screen the form.
  198.  
  199. Asa Dean
  200. PC CONSULTING
  201. 1124 Copper Lantern Court
  202. Modesto, CA 95355
  203. 209/521-5803
  204. 75600,3421
  205.  
  206.  
  207. Page 4
  208.  
  209.